Create Project

Create a new project in the Tenant. Project name must adhere to the following criteria:

1. Must always start with an alphabetic character

2. Maximum length of 256 characters

3. Only letters, digits, spaces, and underscores allowed

POST{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/projects

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Request Body

json

{
  "projectName": "New Project",
  "description": "Description for the new project",
  "cloneConfigFromProjectPid": 5,
  "assignedUsers": [
    {
      "userEmail": "user@example.com",
      "role": "developer",
      "isAdmin": true
    }
  ]
}

Responses

201 - Project created successfully

json

{
  "pid": 3,
  "projectDisplayName": "New Project",
  "projectCode": "NewProject",
  "description": "Description for the new project",
  "createdUserPid": 1,
  "createdTimestamp": 1728040036528
}

400 - Bad Request Error

json

{
  "error": "Project name validation failed: Cannot start with digit, max length 256, only alphabets, digits, spaces, and underscores allowed."
}

403 - Forbidden - User does not have permission to create projects

json

{
  "error": "User do not have authorization to access this feature."
}

404 - Not Found - Invalid cloneConfigFromProjectPid

json

{
  "error": "Project with PID 5 does not exist."
}

409 - Conflict - Duplicate project name

json

{
  "error": "Project with the same name already exists."
}

422 - Unprocessable Entity - Validation errors occurred

json

{
  "error": "User with email 'user@example.com' does not exist."
}

500 - Internal Server Error

No response sample available

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X POST "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/projects" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "projectName": "New Project",
  "description": "Description for the new project",
  "cloneConfigFromProjectPid": 5,
  "assignedUsers": [
    {
      "userEmail": "user@example.com",
      "role": "developer",
      "isAdmin": true
    }
  ]
}'